Add missing introspection annotations
authorPhil Clayton <phil.clayton@lineone.net>
Thu, 5 Sep 2013 00:08:41 +0000 (01:08 +0100)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 10 Sep 2013 21:20:15 +0000 (17:20 -0400)
https://bugzilla.gnome.org/show_bug.cgi?id=707519

gtk/gtkaccelgroup.c
gtk/gtkcellarea.c
gtk/gtkclipboard.c
gtk/gtkrecentchooser.c
gtk/gtkselection.c
gtk/gtktextbufferrichtext.c
gtk/gtktreemodel.c
gtk/gtkwidget.c

index 60bd1ee534c174391e81ead21e4316911881921e..96316b38883c8fe7bbef515a21e3cf2a94e875b6 100644 (file)
@@ -818,7 +818,7 @@ _gtk_accel_group_get_accelerables (GtkAccelGroup *accel_group)
  * @accel_group: the accelerator group to query
  * @accel_key: key value of the accelerator
  * @accel_mods: modifier combination of the accelerator
- * @n_entries: (allow-none): location to return the number
+ * @n_entries: (out) (allow-none): location to return the number
  *     of entries found, or %NULL
  *
  * Queries an accelerator group for all entries matching @accel_key
@@ -1173,8 +1173,8 @@ is_keycode (const gchar *string)
  * @accelerator: string representing an accelerator
  * @accelerator_key: (out) (allow-none): return location for accelerator
  *     keyval, or %NULL
- * @accelerator_codes: (out) (allow-none): return location for accelerator
- *     keycodes, or %NULL
+ * @accelerator_codes: (out) (array zero-terminated=1) (transfer full) (allow-none):
+ *     return location for accelerator keycodes, or %NULL
  * @accelerator_mods: (out) (allow-none): return location for accelerator
  *     modifier mask, %NULL
  *
@@ -1183,6 +1183,9 @@ is_keycode (const gchar *string)
  * useful for system-level components, applications should use
  * gtk_accelerator_parse() instead.
  *
+ * If @accelerator_codes is given and the result stored in it is non-%NULL,
+ * the result must be freed with g_free().
+ *
  * If a keycode is present in the accelerator and no @accelerator_codes
  * is given, the parse will fail.
  *
index b7bad3d559e81abca2c4821e0e28894980da7494..9bd4e10a8e8ca49b6113e3d964c03a41adc95c94 100644 (file)
@@ -2457,7 +2457,7 @@ gtk_cell_area_class_find_cell_property (GtkCellAreaClass   *aclass,
 /**
  * gtk_cell_area_class_list_cell_properties:
  * @aclass: a #GtkCellAreaClass
- * @n_properties: location to return the number of cell properties found
+ * @n_properties: (out): location to return the number of cell properties found
  *
  * Returns all cell properties of a cell area class.
  *
index a460e477bda221181c7630427135d24525f8e5e9..e2c0ace9282a0b654b83b6e5283a74f688b71b1d 100644 (file)
@@ -1490,7 +1490,7 @@ clipboard_rich_text_received_func (GtkClipboard *clipboard,
  * @clipboard: a #GtkClipboard
  * @buffer: a #GtkTextBuffer
  * @format: (out): return location for the format of the returned data
- * @length: return location for the length of the returned data
+ * @length: (out): return location for the length of the returned data
  *
  * Requests the contents of the clipboard as rich text.  This function
  * waits for the data to be received using the main loop, so events,
@@ -1818,7 +1818,7 @@ gtk_clipboard_wait_is_uris_available (GtkClipboard *clipboard)
  * @targets: (out) (array length=n_targets) (transfer container): location
  *           to store an array of targets. The result stored here must
  *           be freed with g_free().
- * @n_targets: location to store number of items in @targets.
+ * @n_targets: (out): location to store number of items in @targets.
  *
  * Returns a list of targets that are present on the clipboard, or %NULL
  * if there aren't any targets available. The returned list must be
index f10790dfa5788dda9e8dc9e317532f6225573e41..05b284ce9f8a5876d2a2a7ad3b1885acb1a75d5f 100644 (file)
@@ -845,7 +845,8 @@ gtk_recent_chooser_get_items (GtkRecentChooser *chooser)
 /**
  * gtk_recent_chooser_get_uris:
  * @chooser: a #GtkRecentChooser
- * @length: (allow-none): return location for a the length of the URI list, or %NULL
+ * @length: (out) (allow-none): return location for a the length of the
+ *     URI list, or %NULL
  *
  * Gets the URI of the recently used resources.
  *
index 67a774f7683107abffe95c8d9a9ddef0e1b6f7f7..84bba6d2603ea5c0cab36c671866d940578b08a6 100644 (file)
@@ -558,8 +558,8 @@ gtk_target_list_remove (GtkTargetList *list,
  * gtk_target_list_find:
  * @list: a #GtkTargetList
  * @target: an interned atom representing the target to search for
- * @info: a pointer to the location to store application info for target,
- *        or %NULL
+ * @info: (out) (allow-none): a pointer to the location to store
+ *        application info for target, or %NULL
  *
  * Looks up a given target in a #GtkTargetList.
  *
index 2bad3ca5fc17ce5c036f35063953f5beafb1332f..8da96054056762a8630ffdb28117bb030f686128 100644 (file)
@@ -400,7 +400,7 @@ gtk_text_buffer_deserialize_get_can_create_tags (GtkTextBuffer *buffer,
 /**
  * gtk_text_buffer_get_serialize_formats:
  * @buffer: a #GtkTextBuffer
- * @n_formats: return location for the number of formats
+ * @n_formats: (out): return location for the number of formats
  *
  * This function returns the rich text serialize formats registered
  * with @buffer using gtk_text_buffer_register_serialize_format() or
@@ -428,7 +428,7 @@ gtk_text_buffer_get_serialize_formats (GtkTextBuffer *buffer,
 /**
  * gtk_text_buffer_get_deserialize_formats:
  * @buffer: a #GtkTextBuffer
- * @n_formats: return location for the number of formats
+ * @n_formats: (out): return location for the number of formats
  *
  * This function returns the rich text deserialize formats registered
  * with @buffer using gtk_text_buffer_register_deserialize_format() or
@@ -460,7 +460,7 @@ gtk_text_buffer_get_deserialize_formats (GtkTextBuffer *buffer,
  * @format: the rich text format to use for serializing
  * @start: start of block of text to serialize
  * @end: end of block of test to serialize
- * @length: return location for the length of the serialized data
+ * @length: (out): return location for the length of the serialized data
  *
  * This function serializes the portion of text between @start
  * and @end in the rich text format represented by @format.
index b4f8ef09a644e1e7b7430fd511c7cb4229a4c166..6e40444bafa773be5ddec850e0d3d8dd91009b26 100644 (file)
@@ -841,7 +841,7 @@ gtk_tree_path_get_indices (GtkTreePath *path)
 /**
  * gtk_tree_path_get_indices_with_depth:
  * @path: a #GtkTreePath
- * @depth: (allow-none): return location for number of elements
+ * @depth: (out) (allow-none): return location for number of elements
  *     returned in the integer array, or %NULL
  *
  * Returns the current indices of @path.
index 67185f2afee3eac5553fb9dce330d9724cc107d6..213a3fe5c370fef52bac92054d742eb68c753a5f 100644 (file)
@@ -12353,7 +12353,7 @@ gtk_widget_class_find_style_property (GtkWidgetClass *klass,
 /**
  * gtk_widget_class_list_style_properties:
  * @klass: a #GtkWidgetClass
- * @n_properties: location to return the number of style properties found
+ * @n_properties: (out): location to return the number of style properties found
  *
  * Returns all style properties of a widget class.
  *